home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / CM / RANDO101.ZIP / SQ2AREAS.DOC < prev    next >
Encoding:
Text File  |  1994-05-14  |  5.6 KB  |  149 lines
  1.      SQ2AREAS:      a SQUISH.CFG to AREAS.BBS converter
  2.                     Copyright (c) 1993, 1994 Jay S. Kendall
  3.                     All rights reserved.
  4.  
  5.  
  6. DISCLAIMER
  7. ----------
  8. This software is provided without any guarantee or warranty either
  9. expressed or implied.  I will not be held responsible for ANY damages that
  10. may result from the use of this program.
  11.  
  12. SQ2AREAS software and documentation copyright (C) 1993, 1994 by Jay
  13. Kendall. All rights reserved.
  14.  
  15.  
  16. LICENSE
  17. -------
  18. This program is being released as FREEWARE.  The source code will remain
  19. the property of the author unless otherwise released by him.
  20.  
  21. You are free to use this version of the program without any cost of
  22. registration.  
  23.  
  24. You may not alter, modify, or reverse engineer SQ2AREAS for any reason,
  25. including but not limited to decompiling-compiling, patching, or
  26. disassembling.
  27.  
  28. You may freely distribute and copy this program for others subject to the
  29. above restrictions and the following:
  30.  
  31.      - SQ2AREAS is copied in unmodified form including this file.
  32.      - There is no charge for copying except for the cost of disks.
  33.      - SQ2AREAS is not included in another software package without the
  34.        express written permission of Jay Kendall.
  35.  
  36.  
  37. WHAT IT DOES
  38. ------------
  39. SQ2AREAS will read a Squish.cfg file, extract "Origin" and "EchoArea"
  40. information, and create an AREAS.BBS file in the current directory.
  41.  
  42. Squish.cfg control flags are translated as follows:
  43.  
  44.      -0                  The indication for a pass-through area is
  45.                          translated into the AREAS.BBS-style leading "#."
  46.  
  47.      -$,-$d,-$m,-$s      In normal operation, the presence of any of these
  48.                          flags will cause a "$" to be placed as the first
  49.                          character in AREAS.BBS line for non-passthru
  50.                          areas, or as the second character in passthru
  51.                          areas.  This may be overridden by use of the -NO$
  52.                          parameter (see below).
  53.  
  54.      -p                  The address following "-p" will not be added to
  55.                          the downlink information in AREAS.BBS. However, if
  56.                          the first downlink listed does not contain all
  57.                          portions of <zone>:<node>/<net>, the missing
  58.                          information will be extracted from the address
  59.                          following "-p." In other words,
  60.                               -p1:234/567   14   2:345/67
  61.                          will be rendered as
  62.                               1:234/14   2:345/67
  63.                          in AREAS.BBS.
  64.  
  65.      -f,-s,-x,-+,-u,-h   These flags have no counterpart in AREAS.BBS; they
  66.                          are ignored by SQ2AREAS.
  67.  
  68.  
  69. SYNTAX
  70. ------
  71. The command syntax for SQ2AREAS is
  72.      SQ2AREAS <Squish config file> "Sysop Name" [-NO$]
  73.  
  74. <Squish config file> should be replaced with the name of the source
  75. Squish.cfg file.  It can be as short as filename.ext, or it can include
  76. drive letter and path if desired.
  77.  
  78. "Sysop Name" should be replaced with your name as you want it to appear in
  79. the destination AREAS.BBS.  It MUST be enclosed within quotation marks.
  80.  
  81. -NO$ is an optional parameter; see the section on the "pure" AREAS.BBS
  82. option, below.
  83.  
  84.  
  85. PROGRAM LIMITATIONS
  86. -------------------
  87. SQ2AREAS scans the Squish config file for the "Origin" keyword before
  88. performing any other operations.  While it doesn't affect normal Squish
  89. operations if the "Origin" keyword follows an "EchoArea" keyword, SQ2AREAS
  90. considers it an error.
  91.  
  92. "Attractive" formatting of the new AREAS.BBS can only be done if:
  93.      - pathnames in Squish.cfg are 22 characters or less, and
  94.      - echotags are 18 characters or less.
  95. SQ2AREAS will perform properly even if neither of these conditions are met,
  96. but columns in AREAS.BBS will not be neatly aligned.
  97.  
  98. The new AREAS.BBS file will be created in the current directory, and will
  99. overwrite any already-existing AREAS.BBS.
  100.  
  101.  
  102. THE "PURE" AREAS.BBS OPTION:  -NO$
  103. ----------------------------------
  104. SQ2AREAS default behavior is to add a '$' to the pathname in AREAS.BBS if
  105. it encounters a Squish-specific flag (-$, -$d, -$m, or -$s) in an EchoArea
  106. statement.
  107.  
  108. The original specifications for AREAS.BBS don't allow for the presence of
  109. the Squish $ flag.  In the event you have software which won't function
  110. properly if your pathnames contain a '$', you can call SQ2AREAS with the -
  111. NO$ parameter, which will suppress Squish-specific "$" flags.
  112.  
  113.  
  114. ERRORLEVELS
  115. -----------
  116. SQ2AREAS returns an errorlevel of 0 after successful operation.  In the
  117. event of difficulties, one of the following errorlevels will be returned.
  118.  
  119.        1  Error opening Squish config file for input
  120.        2  Error creating AREAS.BBS for output
  121.        3  EchoArea keyword encountered in Squish config file before Origin
  122.           keyword
  123.      255  Improper arguments on command line
  124.  
  125.  
  126. FINAL NOTES
  127. -----------
  128. Contacting me:  
  129.  
  130.           BBS                 HAL 9000
  131.                               (203) 934-8432
  132.  
  133.           Fidonet             1:141/338
  134.  
  135.           Internet            Jay.Kendall@f338.n141.z1.fidonet.org
  136.  
  137.           US Mail             Jay Kendall
  138.                               70 Turnpike Square
  139.                               Suite 160
  140.                               Milford, CT 06460
  141.  
  142. Thanks to Jeffrey Lizotte for encouraging me to proceed with this project,
  143. and for beta-testing above and beyond the call of duty. Thanks to Don
  144. Dawson for his comments regarding handling of the "-p" flag, and for
  145. further beta-testing.
  146.  
  147. SQ2AREAS was compiled with Borland's Turbo C++ for DOS.
  148.  
  149. "Squish" is a trademark of Scott J. Dudley.